<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.9.1" />
<title>substrateinterface.utils.ss58 API documentation</title>
<meta name="description" content="SS58 is a simple address format designed for Substrate based chains.
Encoding/decoding according to specification on …" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>substrateinterface.utils.ss58</code></h1>
</header>
<section id="section-intro">
<p>SS58 is a simple address format designed for Substrate based chains.
Encoding/decoding according to specification on <a href="https://wiki.parity.io/External-Address-Format-(SS58)">https://wiki.parity.io/External-Address-Format-(SS58)</a></p>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python"># Python Substrate Interface Library
#
# Copyright 2018-2020 Stichting Polkascan (Polkascan Foundation).
#
# Licensed under the Apache License, Version 2.0 (the &#34;License&#34;);
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an &#34;AS IS&#34; BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
#  ss58.py

&#34;&#34;&#34; SS58 is a simple address format designed for Substrate based chains.
    Encoding/decoding according to specification on https://wiki.parity.io/External-Address-Format-(SS58)

&#34;&#34;&#34;
import warnings
import base58
from hashlib import blake2b

from scalecodec import ScaleBytes
from scalecodec.types import U8, U16, U32, U64


def ss58_decode(address, valid_ss58_format=None, valid_address_type=None):
    &#34;&#34;&#34;
    Decodes given SS58 encoded address to an account ID
    Parameters
    ----------
    address: e.g. EaG2CRhJWPb7qmdcJvy3LiWdh26Jreu9Dx6R1rXxPmYXoDk
    valid_ss58_format
    valid_address_type

    Returns
    -------
    Decoded string AccountId
    &#34;&#34;&#34;

    if valid_address_type is not None:
        warnings.warn(&#34;Keyword &#39;valid_address_type&#39; will be replaced by &#39;valid_ss58_format&#39;&#34;, DeprecationWarning)
        valid_ss58_format = valid_address_type

    checksum_prefix = b&#39;SS58PRE&#39;

    ss58_format = base58.b58decode(address)

    if valid_ss58_format is not None and ss58_format[0] != valid_ss58_format:
        raise ValueError(&#34;Invalid Address type&#34;)

    # Determine checksum length according to length of address string
    if len(ss58_format) in [3, 4, 6, 10]:
        checksum_length = 1
    elif len(ss58_format) in [5, 7, 11, 35]:
        checksum_length = 2
    elif len(ss58_format) in [8, 12]:
        checksum_length = 3
    elif len(ss58_format) in [9, 13]:
        checksum_length = 4
    elif len(ss58_format) in [14]:
        checksum_length = 5
    elif len(ss58_format) in [15]:
        checksum_length = 6
    elif len(ss58_format) in [16]:
        checksum_length = 7
    elif len(ss58_format) in [17]:
        checksum_length = 8
    else:
        raise ValueError(&#34;Invalid address length&#34;)

    checksum = blake2b(checksum_prefix + ss58_format[0:-checksum_length]).digest()

    if checksum[0:checksum_length] != ss58_format[-checksum_length:]:
        raise ValueError(&#34;Invalid checksum&#34;)

    return ss58_format[1:len(ss58_format)-checksum_length].hex()


def ss58_encode(address, ss58_format=42, address_type=None):
    &#34;&#34;&#34;
    Encodes an account ID to an Substrate address according to provided address_type

    Parameters
    ----------
    address
    ss58_format
    address_type: (deprecated)

    Returns
    -------

    &#34;&#34;&#34;
    checksum_prefix = b&#39;SS58PRE&#39;

    if address_type is not None:
        warnings.warn(&#34;Keyword &#39;address_type&#39; will be replaced by &#39;ss58_format&#39;&#34;, DeprecationWarning)
        ss58_format = address_type

    if type(address) is bytes or type(address) is bytearray:
        address_bytes = address
    else:
        address_bytes = bytes.fromhex(address.replace(&#39;0x&#39;, &#39;&#39;))

    if len(address_bytes) == 32:
        # Checksum size is 2 bytes for public key
        checksum_length = 2
    elif len(address_bytes) in [1, 2, 4, 8]:
        # Checksum size is 1 byte for account index
        checksum_length = 1
    else:
        raise ValueError(&#34;Invalid length for address&#34;)

    address_format = bytes([ss58_format]) + address_bytes
    checksum = blake2b(checksum_prefix + address_format).digest()

    return base58.b58encode(address_format + checksum[:checksum_length]).decode()


def ss58_encode_account_index(account_index, ss58_format=42, address_type=None):
    &#34;&#34;&#34;
    Encodes an AccountIndex to an Substrate address according to provided address_type

    Parameters
    ----------
    account_index
    ss58_format
    address_type: (deprecated)

    Returns
    -------

    &#34;&#34;&#34;

    if address_type is not None:
        warnings.warn(&#34;Keyword &#39;address_type&#39; will be replaced by &#39;ss58_format&#39;&#34;, DeprecationWarning)
        ss58_format = address_type

    if 0 &lt;= account_index &lt;= 2**8 - 1:
        account_idx_encoder = U8()
    elif 2**8 &lt;= account_index &lt;= 2**16 - 1:
        account_idx_encoder = U16()
    elif 2**16 &lt;= account_index &lt;= 2**32 - 1:
        account_idx_encoder = U32()
    elif 2**32 &lt;= account_index &lt;= 2**64 - 1:
        account_idx_encoder = U64()
    else:
        raise ValueError(&#34;Value too large for an account index&#34;)

    return ss58_encode(account_idx_encoder.encode(account_index).data, ss58_format)


def ss58_decode_account_index(address, valid_ss58_format=None, valid_address_type=None):
    &#34;&#34;&#34;
    Decodes given SS58 encoded address to an AccountIndex

    Parameters
    ----------
    address
    valid_ss58_format
    valid_address_type

    Returns
    -------
    Decoded int AccountIndex
    &#34;&#34;&#34;

    if valid_address_type is not None:
        warnings.warn(&#34;Keyword &#39;valid_address_type&#39; will be replaced by &#39;valid_ss58_format&#39;&#34;, DeprecationWarning)
        valid_ss58_format = valid_address_type

    account_index_bytes = ss58_decode(address, valid_ss58_format)

    if len(account_index_bytes) == 2:
        return U8(ScaleBytes(&#39;0x{}&#39;.format(account_index_bytes))).decode()
    if len(account_index_bytes) == 4:
        return U16(ScaleBytes(&#39;0x{}&#39;.format(account_index_bytes))).decode()
    if len(account_index_bytes) == 8:
        return U32(ScaleBytes(&#39;0x{}&#39;.format(account_index_bytes))).decode()
    if len(account_index_bytes) == 16:
        return U64(ScaleBytes(&#39;0x{}&#39;.format(account_index_bytes))).decode()
    else:
        raise ValueError(&#34;Invalid account index length&#34;)</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="substrateinterface.utils.ss58.ss58_decode"><code class="name flex">
<span>def <span class="ident">ss58_decode</span></span>(<span>address, valid_ss58_format=None, valid_address_type=None)</span>
</code></dt>
<dd>
<div class="desc"><p>Decodes given SS58 encoded address to an account ID
Parameters</p>
<hr>
<dl>
<dt><strong><code>address</code></strong> :&ensp;<code>e.g. EaG2CRhJWPb7qmdcJvy3LiWdh26Jreu9Dx6R1rXxPmYXoDk</code></dt>
<dd>&nbsp;</dd>
<dt><strong><code>valid_ss58_format</code></strong></dt>
<dd>&nbsp;</dd>
<dt><strong><code>valid_address_type</code></strong></dt>
<dd>&nbsp;</dd>
</dl>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>Decoded string AccountId</code></dt>
<dd>&nbsp;</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def ss58_decode(address, valid_ss58_format=None, valid_address_type=None):
    &#34;&#34;&#34;
    Decodes given SS58 encoded address to an account ID
    Parameters
    ----------
    address: e.g. EaG2CRhJWPb7qmdcJvy3LiWdh26Jreu9Dx6R1rXxPmYXoDk
    valid_ss58_format
    valid_address_type

    Returns
    -------
    Decoded string AccountId
    &#34;&#34;&#34;

    if valid_address_type is not None:
        warnings.warn(&#34;Keyword &#39;valid_address_type&#39; will be replaced by &#39;valid_ss58_format&#39;&#34;, DeprecationWarning)
        valid_ss58_format = valid_address_type

    checksum_prefix = b&#39;SS58PRE&#39;

    ss58_format = base58.b58decode(address)

    if valid_ss58_format is not None and ss58_format[0] != valid_ss58_format:
        raise ValueError(&#34;Invalid Address type&#34;)

    # Determine checksum length according to length of address string
    if len(ss58_format) in [3, 4, 6, 10]:
        checksum_length = 1
    elif len(ss58_format) in [5, 7, 11, 35]:
        checksum_length = 2
    elif len(ss58_format) in [8, 12]:
        checksum_length = 3
    elif len(ss58_format) in [9, 13]:
        checksum_length = 4
    elif len(ss58_format) in [14]:
        checksum_length = 5
    elif len(ss58_format) in [15]:
        checksum_length = 6
    elif len(ss58_format) in [16]:
        checksum_length = 7
    elif len(ss58_format) in [17]:
        checksum_length = 8
    else:
        raise ValueError(&#34;Invalid address length&#34;)

    checksum = blake2b(checksum_prefix + ss58_format[0:-checksum_length]).digest()

    if checksum[0:checksum_length] != ss58_format[-checksum_length:]:
        raise ValueError(&#34;Invalid checksum&#34;)

    return ss58_format[1:len(ss58_format)-checksum_length].hex()</code></pre>
</details>
</dd>
<dt id="substrateinterface.utils.ss58.ss58_decode_account_index"><code class="name flex">
<span>def <span class="ident">ss58_decode_account_index</span></span>(<span>address, valid_ss58_format=None, valid_address_type=None)</span>
</code></dt>
<dd>
<div class="desc"><p>Decodes given SS58 encoded address to an AccountIndex</p>
<h2 id="parameters">Parameters</h2>
<dl>
<dt><strong><code>address</code></strong></dt>
<dd>&nbsp;</dd>
<dt><strong><code>valid_ss58_format</code></strong></dt>
<dd>&nbsp;</dd>
<dt><strong><code>valid_address_type</code></strong></dt>
<dd>&nbsp;</dd>
</dl>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>Decoded int AccountIndex</code></dt>
<dd>&nbsp;</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def ss58_decode_account_index(address, valid_ss58_format=None, valid_address_type=None):
    &#34;&#34;&#34;
    Decodes given SS58 encoded address to an AccountIndex

    Parameters
    ----------
    address
    valid_ss58_format
    valid_address_type

    Returns
    -------
    Decoded int AccountIndex
    &#34;&#34;&#34;

    if valid_address_type is not None:
        warnings.warn(&#34;Keyword &#39;valid_address_type&#39; will be replaced by &#39;valid_ss58_format&#39;&#34;, DeprecationWarning)
        valid_ss58_format = valid_address_type

    account_index_bytes = ss58_decode(address, valid_ss58_format)

    if len(account_index_bytes) == 2:
        return U8(ScaleBytes(&#39;0x{}&#39;.format(account_index_bytes))).decode()
    if len(account_index_bytes) == 4:
        return U16(ScaleBytes(&#39;0x{}&#39;.format(account_index_bytes))).decode()
    if len(account_index_bytes) == 8:
        return U32(ScaleBytes(&#39;0x{}&#39;.format(account_index_bytes))).decode()
    if len(account_index_bytes) == 16:
        return U64(ScaleBytes(&#39;0x{}&#39;.format(account_index_bytes))).decode()
    else:
        raise ValueError(&#34;Invalid account index length&#34;)</code></pre>
</details>
</dd>
<dt id="substrateinterface.utils.ss58.ss58_encode"><code class="name flex">
<span>def <span class="ident">ss58_encode</span></span>(<span>address, ss58_format=42, address_type=None)</span>
</code></dt>
<dd>
<div class="desc"><p>Encodes an account ID to an Substrate address according to provided address_type</p>
<h2 id="parameters">Parameters</h2>
<dl>
<dt><strong><code>address</code></strong></dt>
<dd>&nbsp;</dd>
<dt><strong><code>ss58_format</code></strong></dt>
<dd>&nbsp;</dd>
<dt><strong><code>address_type</code></strong> :&ensp;<code>(deprecated)</code></dt>
<dd>&nbsp;</dd>
</dl>
<h2 id="returns">Returns</h2></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def ss58_encode(address, ss58_format=42, address_type=None):
    &#34;&#34;&#34;
    Encodes an account ID to an Substrate address according to provided address_type

    Parameters
    ----------
    address
    ss58_format
    address_type: (deprecated)

    Returns
    -------

    &#34;&#34;&#34;
    checksum_prefix = b&#39;SS58PRE&#39;

    if address_type is not None:
        warnings.warn(&#34;Keyword &#39;address_type&#39; will be replaced by &#39;ss58_format&#39;&#34;, DeprecationWarning)
        ss58_format = address_type

    if type(address) is bytes or type(address) is bytearray:
        address_bytes = address
    else:
        address_bytes = bytes.fromhex(address.replace(&#39;0x&#39;, &#39;&#39;))

    if len(address_bytes) == 32:
        # Checksum size is 2 bytes for public key
        checksum_length = 2
    elif len(address_bytes) in [1, 2, 4, 8]:
        # Checksum size is 1 byte for account index
        checksum_length = 1
    else:
        raise ValueError(&#34;Invalid length for address&#34;)

    address_format = bytes([ss58_format]) + address_bytes
    checksum = blake2b(checksum_prefix + address_format).digest()

    return base58.b58encode(address_format + checksum[:checksum_length]).decode()</code></pre>
</details>
</dd>
<dt id="substrateinterface.utils.ss58.ss58_encode_account_index"><code class="name flex">
<span>def <span class="ident">ss58_encode_account_index</span></span>(<span>account_index, ss58_format=42, address_type=None)</span>
</code></dt>
<dd>
<div class="desc"><p>Encodes an AccountIndex to an Substrate address according to provided address_type</p>
<h2 id="parameters">Parameters</h2>
<dl>
<dt><strong><code>account_index</code></strong></dt>
<dd>&nbsp;</dd>
<dt><strong><code>ss58_format</code></strong></dt>
<dd>&nbsp;</dd>
<dt><strong><code>address_type</code></strong> :&ensp;<code>(deprecated)</code></dt>
<dd>&nbsp;</dd>
</dl>
<h2 id="returns">Returns</h2></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def ss58_encode_account_index(account_index, ss58_format=42, address_type=None):
    &#34;&#34;&#34;
    Encodes an AccountIndex to an Substrate address according to provided address_type

    Parameters
    ----------
    account_index
    ss58_format
    address_type: (deprecated)

    Returns
    -------

    &#34;&#34;&#34;

    if address_type is not None:
        warnings.warn(&#34;Keyword &#39;address_type&#39; will be replaced by &#39;ss58_format&#39;&#34;, DeprecationWarning)
        ss58_format = address_type

    if 0 &lt;= account_index &lt;= 2**8 - 1:
        account_idx_encoder = U8()
    elif 2**8 &lt;= account_index &lt;= 2**16 - 1:
        account_idx_encoder = U16()
    elif 2**16 &lt;= account_index &lt;= 2**32 - 1:
        account_idx_encoder = U32()
    elif 2**32 &lt;= account_index &lt;= 2**64 - 1:
        account_idx_encoder = U64()
    else:
        raise ValueError(&#34;Value too large for an account index&#34;)

    return ss58_encode(account_idx_encoder.encode(account_index).data, ss58_format)</code></pre>
</details>
</dd>
</dl>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="substrateinterface.utils" href="index.html">substrateinterface.utils</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="substrateinterface.utils.ss58.ss58_decode" href="#substrateinterface.utils.ss58.ss58_decode">ss58_decode</a></code></li>
<li><code><a title="substrateinterface.utils.ss58.ss58_decode_account_index" href="#substrateinterface.utils.ss58.ss58_decode_account_index">ss58_decode_account_index</a></code></li>
<li><code><a title="substrateinterface.utils.ss58.ss58_encode" href="#substrateinterface.utils.ss58.ss58_encode">ss58_encode</a></code></li>
<li><code><a title="substrateinterface.utils.ss58.ss58_encode_account_index" href="#substrateinterface.utils.ss58.ss58_encode_account_index">ss58_encode_account_index</a></code></li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.1</a>.</p>
</footer>
</body>
</html>